Skip to main content
Version: 1.2.3

Bot API

Table of Contents​

Overview​

This document provides comprehensive documentation for the Bot Management API. The API is organized into multiple endpoints allowing users to create, manage, and interact with chatbots.

Security​

The API uses OAuth 2.0 for authentication. Most endpoints require a Bearer token for authorization.

// Example of using Bearer token
const headers = {
  'Authorization': 'Bearer your_token_here',
  'Content-Type': 'application/json'
};

The API is available in multiple versions (v1, v2, and v3) with increasing functionality. We recommend using the most recent version (v3) for new integrations.

Health Endpoints​

GET /aiwb/bot/api/v1/healthz​

  • Method: GET
  • Summary: Health Check
  • Description: Returns the health status of the API service.
  • Operation ID: health_check_v1

Request Payload:​

No parameters required

Example Response:​

{
  "msg": "Service is healthy"
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json

GET /aiwb/bot/api/v3/healthz​

  • Method: GET
  • Summary: Health Check (V3)
  • Description: Returns the health status of the API service (V3 version).
  • Operation ID: health_check_v3

Request Payload:​

No parameters required

Example Response:​

{
  "msg": "Service is healthy"
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json

Bot Management​

V1 Endpoints​

GET /aiwb/bot/api/v1/​

  • Method: GET
  • Summary: List Chat Bots
  • Description: Retrieve a list of available chat bots with pagination and filtering options.
  • Operation ID: list_chat_bots_v1

Parameters:​

ParameterTypeDescriptionRequired
page_nointegerPage number (default: 1)No
page_sizeintegerItems per page (default: 10)No
filterstringFilter stringNo
orderstringSort order (asc/desc)No
is_publishedbooleanFilter by published statusNo
deletedbooleanFilter by deleted statusNo

Example Response:​

{
  "status_code": "200",
  "total_bot_count": 2,
  "chat_bots": [
    {
      "chat_bot_id": "d781c0f9-3b95-45b4-8de5-dede1521c4dd",
      "chatbotName": "George Washington",
      "creation_time": "2023-12-18T03:29:39",
      "chatbotDescription": "This Bot is Capable of addressing queries about George Washington",
      "modelId": "Anthropic"
    },
    {
      "chat_bot_id": "2d1e5624-46d6-49f6-bf7c-fa6f16c0f693",
      "chatbotName": "Summarization",
      "creation_time": "2023-12-18T17:35:56",
      "chatbotDescription": "This Bot is Capable of Summarizing the Texts",
      "modelId": "1"
    }
  ]
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
500Internal Server Errorapplication/json

POST /aiwb/bot/api/v1/​

  • Method: POST
  • Summary: Create Chat Bot
  • Description: Create a new chatbot with specified configuration parameters.
  • Operation ID: create_chat_bot_v1

Request Body:​

{
  "chatbotName": "History Helper",
  "chatbotDescription": "This bot assists with historical inquiries",
  "modelId": "OpenAI",
  "modelVersion": "gpt-35-turbo",
  "context": "You are a helpful historical assistant.",
  "temperature": 0.7,
  "max_tokens": 150,
  "folder_ids": [],
  "object_ids": [],
  "guideline_object_ids": [],
  "template_object_id": ["1234567"]
}

Required Fields:

  • chatbotName (min length: 3)
  • modelId (min length: 3)
  • modelVersion (min length: 2)

Example Response:​

{
  "status_code": "201",
  "message": "Bot Created : Bot Created Successfully",
  "chat_bot_id": "3a4b5c6d-7e8f-9g0h-1i2j-3k4l5m6n7o8p"
}

Responses:

Status CodeDescriptionContent-Type
201Createdapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
422Validation Errorapplication/json
500Internal Server Errorapplication/json

GET /aiwb/bot/api/v1/{chatbot_global_id}​

  • Method: GET
  • Summary: Get Chat Bot by ID
  • Description: Retrieve detailed information about a specific chatbot by ID.
  • Operation ID: get_chat_bot_by_id_v1

Parameters:​

ParameterTypeDescriptionRequired
chatbot_global_idstring (uuid)Unique identifier for the chatbotYes

Example Response:​

{
  "status_code": 200,
  "chat_bot_id": "c3f2cef8-3121-4bce-a787-ae0458aea70a",
  "chat_bot_data": [
    {
      "id": 109,
      "key_id": "modelId",
      "value": "Openai"
    },
    {
      "id": 110,
      "key_id": "chatbotName",
      "value": "George Washington-Demo"
    },
    {
      "id": 111,
      "key_id": "context",
      "value": "Answer as If you are George Washington"
    }
  ],
  "examples_data": [
    {
      "id": 1,
      "chatbot_profile_id": "1e04f005-c102-4781-97f9-b3a0ce3ac1b3",
      "question": "How are you?",
      "answer": "I am Doing Well, Thank you for Asking"
    }
  ],
  "guard_rails": [
    {
      "id": 16,
      "guard_rail": "kill"
    }
  ]
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
500Internal Server Errorapplication/json

PUT /aiwb/bot/api/v1/{chatbot_global_id}​

  • Method: PUT
  • Summary: Update Chat Bot
  • Description: Update an existing chatbot's configuration.
  • Operation ID: update_chat_bot_v1

Parameters:​

ParameterTypeDescriptionRequired
chatbot_global_idstring (uuid)Unique identifier for the chatbotYes

Request Body:​

Same as Create Chat Bot, but all fields are optional except for required ones.

Required Fields:

  • chatbotName (min length: 3)
  • modelId (min length: 3)
  • modelVersion (min length: 2)

Example Response:​

{
  "status_code": "200",
  "message": "Bot Update : Bot Updated Successfully"
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
422Validation Errorapplication/json
500Internal Server Errorapplication/json

DELETE /aiwb/bot/api/v1/{chatbot_global_id}​

  • Method: DELETE
  • Summary: Delete Chat Bot
  • Description: Permanently remove a chatbot and all its associated data.
  • Operation ID: delete_chat_bot_v1

Parameters:​

ParameterTypeDescriptionRequired
chatbot_global_idstring (uuid)Unique identifier for the chatbotYes

Example Response:​

{
  "status_code": "200",
  "message": "Successfully deleted Chat Sessions and all it's associated data such as Guard Rails, Examples, User Query & bot Response !!"
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
500Internal Server Errorapplication/json

PATCH /aiwb/bot/api/v1/{chatbot_global_id}​

  • Method: PATCH
  • Summary: Set Active/Inactive Status
  • Description: Toggle the active status of a chatbot. Only superadmins and tenant admins can use this endpoint.
  • Operation ID: set_active_status_v1

Parameters:​

ParameterTypeDescriptionRequired
chatbot_global_idstring (uuid)Unique identifier for the chatbotYes

Request Body:​

{
  "is_active": true
}

Example Response:​

{
  "status_code": 200,
  "message": "Agent is now active."
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
500Internal Server Errorapplication/json

POST /aiwb/bot/api/v1/publish/{chatbot_global_id}​

  • Method: POST
  • Summary: Publish Chat Bot
  • Description: Publish a chatbot, making it available for end-users.
  • Operation ID: publish_chat_bot_v1

Parameters:​

ParameterTypeDescriptionRequired
chatbot_global_idstring (uuid)Unique identifier for the chatbotYes

Example Response:​

{
  "status_code": 200,
  "message": "Bot published successfully"
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
500Internal Server Errorapplication/json

POST /aiwb/bot/api/v1/unpublish/{chatbot_global_id}​

  • Method: POST
  • Summary: Unpublish Chat Bot
  • Description: Unpublish a previously published chatbot.
  • Operation ID: unpublish_chat_bot_v1

Parameters:​

ParameterTypeDescriptionRequired
chatbot_global_idstring (uuid)Unique identifier for the chatbotYes

Example Response:​

{
  "status_code": 200,
  "message": "Bot unpublished successfully"
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
500Internal Server Errorapplication/json

V2 Endpoints​

GET /aiwb/bot/api/v2/​

  • Method: GET
  • Summary: List Chat Bots (V2)
  • Description: Enhanced version of the List Chat Bots API with additional grouping and filtering capabilities.
  • Operation ID: list_chat_bots_v2

Parameters:​

All V1 parameters plus:

ParameterTypeDescriptionRequired
filter_bystringField to filter byNo
group_bystringField to group results byNo
published_by_superadmin_onlybooleanFilter for bots published by superadmins onlyNo

Example Response (Grouped by Model Version):​

{
  "status_code": 200,
  "message": "Bots fetched successfully",
  "total_bot_count": 34,
  "chat_bots": [
    {
      "gpt-35-turbo": [
        {
          "chat_bot_id": "xxxx-xxxx-xxxx-xxxx",
          "chatbotName": "Agent1",
          "creation_time": "2024-03-27 11:15:42",
          "created_by": "abc",
          "chatbotDescription": "Test Agent",
          "modelVersion": "gpt-35-turbo",
          "modelId": "OpenAI",
          "is_editable": false
        }
      ],
      "gemini-pro": [
        {
          "chat_bot_id": "xxxx-xxxx-xxxx-xxxx",
          "chatbotName": "Agent3",
          "creation_time": "2024-05-02 02:34:22",
          "created_by": "xyz",
          "chatbotDescription": "Test Agent",
          "modelVersion": "gemini-pro",
          "modelId": "Palm",
          "is_editable": false
        }
      ]
    }
  ]
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
500Internal Server Errorapplication/json

POST /aiwb/bot/api/v2/​

  • Method: POST
  • Summary: Create Chat Bot (V2)
  • Description: Enhanced version of the Create Chat Bot API.
  • Operation ID: create_chat_bot_v2

Request Body:​

Same as V1, with some additional fields.

Example Response:​

Same as V1 response.

Responses:

Status CodeDescriptionContent-Type
201Createdapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
422Validation Errorapplication/json
500Internal Server Errorapplication/json

PUT /aiwb/bot/api/v2/{chatbot_global_id}​

  • Method: PUT
  • Summary: Update Chat Bot (V2)
  • Description: Enhanced version of the Update Chat Bot API. In this version, all fields are optional except modelId and modelVersion.
  • Operation ID: update_chat_bot_v2

Request Body:​

Similar to V1, but with only modelId and modelVersion as required fields.

Example Response:​

Same as V1 response.

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
422Validation Errorapplication/json
500Internal Server Errorapplication/json

GET /aiwb/bot/api/v2/models/​

  • Method: GET
  • Summary: Get Models Details (V2)
  • Description: Retrieve details about available models with filtering options.
  • Operation ID: get_models_details_v2

Parameters:​

ParameterTypeDescriptionRequired
providerstringFilter by provider nameNo
model_namestringFilter by model nameNo

Example Response:​

Returns details about available models.

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
500Internal Server Errorapplication/json

V3 Endpoints​

POST /aiwb/bot/api/v3/List/​

  • Method: POST
  • Summary: List Chat Bots (V3)
  • Description: V3 version of the List Chat Bots API with enhanced filtering capabilities.
  • Operation ID: list_chat_bots_v3

Request Body:​

{
  "page_no": 1,
  "page_size": 10,
  "filter": [
    {
      "filter_by": "chatbotName",
      "filter": "Agent",
      "skip_exact": false
    }
  ],
  "order": "asc",
  "group_by": "created_by",
  "is_published": false,
  "published_by_superadmin_only": false
}

Example Response:​

Similar to V2 List Chat Bots, with enhanced grouping and filtering capabilities.

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
422Validation Errorapplication/json
500Internal Server Errorapplication/json

POST /aiwb/bot/api/v3/​

  • Method: POST
  • Summary: Create Chat Bot (V3)
  • Description: V3 version of the Create Chat Bot API with more required fields for better configuration.
  • Operation ID: create_chat_bot_v3

Request Body:​

Similar to V2, but with additional required fields:

  • context
  • temperature
  • max_tokens
  • top_p
  • top_k
  • frequency_penalty
  • presence_penalty

Example Response:​

Similar to V2.

Responses:

Status CodeDescriptionContent-Type
201Createdapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
422Validation Errorapplication/json
500Internal Server Errorapplication/json

GET /aiwb/bot/api/v3/{chatbot_global_id}​

  • Method: GET
  • Summary: Get Chat Bot by ID (V3)
  • Description: V3 version of the Get Chat Bot endpoint with improved error handling.
  • Operation ID: get_chat_bot_by_id_v3

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
500Internal Server Errorapplication/json

PUT /aiwb/bot/api/v3/{chatbot_global_id}​

  • Method: PUT
  • Summary: Update Chat Bot (V3)
  • Description: V3 version of the Update Chat Bot endpoint with improved validation.
  • Operation ID: update_chat_bot_v3

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
422Validation Errorapplication/json
500Internal Server Errorapplication/json

DELETE /aiwb/bot/api/v3/{chatbot_global_id}​

  • Method: DELETE
  • Summary: Delete Chat Bot (V3)
  • Description: V3 version of the Delete Chat Bot endpoint with improved error handling.
  • Operation ID: delete_chat_bot_v3

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
500Internal Server Errorapplication/json

PATCH /aiwb/bot/api/v3/{chatbot_global_id}​

  • Method: PATCH
  • Summary: Set Active/Inactive Status (V3)
  • Description: V3 version of the Set Active/Inactive Status endpoint.
  • Operation ID: set_active_status_v3

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
500Internal Server Errorapplication/json

POST /aiwb/bot/api/v3/publish/{chatbot_global_id}​

  • Method: POST
  • Summary: Publish Chat Bot (V3)
  • Description: V3 version of the Publish Chat Bot endpoint.
  • Operation ID: publish_chat_bot_v3

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
500Internal Server Errorapplication/json

POST /aiwb/bot/api/v3/unpublish/{chatbot_global_id}​

  • Method: POST
  • Summary: Unpublish Chat Bot (V3)
  • Description: V3 version of the Unpublish Chat Bot endpoint.
  • Operation ID: unpublish_chat_bot_v3

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
500Internal Server Errorapplication/json

Embedding​

GET /aiwb/bot/api/v1/embed/get_credentials/{chatbot_global_id}​

  • Method: GET
  • Summary: Get Embed Credentials
  • Description: Retrieve embedding credentials for a published chatbot.
  • Operation ID: get_embed_credentials_v1

Parameters:​

ParameterTypeDescriptionRequired
chatbot_global_idstring (uuid)Unique identifier for the chatbotYes

Example Response:​

{
  "status_code": 200,
  "message": "Successfully fetched embedding parameters for chatbot Bot123.",
  "data": {
    "token_url": "https://api-xyz.co/auth/api/v1/oauth/connect/token",
    "refresh_url": "https://api-xyz.co/auth/api/v1/oauth/connect/refresh",
    "chat_url": "https://api-xyz.co/aiwb/chat/api/v2/994548a0-c910-4fa0-b2e2-58ea7dbd3abc?ext_user_id_ref=<user_id of bot user>",
    "client_id": "58842435-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "client_secret": "090458109309240AB420480a01a1eb7f7af761afa290"
  }
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
500Internal Server Errorapplication/json

GET /aiwb/bot/api/v3/embed/get_credentials/{chatbot_global_id}​

  • Method: GET
  • Summary: Get Embed Credentials (V3)
  • Description: V3 version of the Get Embed Credentials endpoint.
  • Operation ID: get_embed_credentials_v3

Responses:

Same as V1 version.

POST /aiwb/bot/api/v1/embed/generate_credentials/{chatbot_global_id}​

  • Method: POST
  • Summary: Generate Embed Credentials
  • Description: Generate or regenerate embedding credentials for a published chatbot.
  • Operation ID: generate_embed_credentials_v1

Parameters:​

ParameterTypeDescriptionRequired
chatbot_global_idstring (uuid)Unique identifier for the chatbotYes

Request Body:​

{
  "target": "KadalTest",
  "access_token_lifespan": 3600
}

Example Response:​

{
  "status_code": 200,
  "message": "Successfully generated client credentials for chatbot Bot123.",
  "data": {
    "client_id": "53a81240-xxxx-xxxx-xxxxxxxxxxxx",
    "client_secret": "599a7b7d1969623B6631F81D11a90a0909241204482A",
    "target": "KadalTest"
  }
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
500Internal Server Errorapplication/json

POST /aiwb/bot/api/v3/embed/generate_credentials/{chatbot_global_id}​

  • Method: POST
  • Summary: Generate Embed Credentials (V3)
  • Description: V3 version of the Generate Embed Credentials endpoint.
  • Operation ID: generate_embed_credentials_v3

Responses:

Same as V1 version.

Models​

GET /aiwb/bot/api/v1/models/​

  • Method: GET
  • Summary: Get Models Details
  • Description: Retrieve information about available AI models for chatbots.
  • Operation ID: get_models_details_v1

Example Response:​

Details about available models including their parameters, capabilities, and versions.

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
500Internal Server Errorapplication/json

Targets​

GET /aiwb/bot/api/v1/targets/​

  • Method: GET
  • Summary: Get Targets
  • Description: Retrieve a list of available targets for chatbot embedding.
  • Operation ID: get_targets_v1

Example Response:​

{
  "status_code": 200,
  "message": "Successfully fetched supported targets.",
  "data": [
    {
      "id": 1,
      "target_name": "test",
      "domain_name": "abc.com"
    },
    {
      "id": 2,
      "target_name": "test1",
      "domain_name": "abcd.com"
    }
  ]
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
500Internal Server Errorapplication/json

GET /aiwb/bot/api/v3/targets/​

  • Method: GET
  • Summary: Get Targets (V3)
  • Description: V3 version of the Get Targets endpoint.
  • Operation ID: get_targets_v3

Responses:

Same as V1 version.

POST /aiwb/bot/api/v1/targets/​

  • Method: POST
  • Summary: Create Target
  • Description: Create a new target for chatbot embedding.
  • Operation ID: create_target_v1

Request Body:​

{
  "target_name": "new_target",
  "domain_name": "example.com"
}

Example Response:​

{
  "status_code": 201,
  "message": "Successfully created target new_target.",
  "data": {
    "id": 3,
    "target_name": "new_target",
    "domain_name": "example.com"
  }
}

Responses:

Status CodeDescriptionContent-Type
201Createdapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
409Conflictapplication/json
500Internal Server Errorapplication/json

POST /aiwb/bot/api/v3/targets/​

  • Method: POST
  • Summary: Create Target (V3)
  • Description: V3 version of the Create Target endpoint.
  • Operation ID: create_target_v3

Responses:

Same as V1 version.

PUT /aiwb/bot/api/v1/targets/{target_id}​

  • Method: PUT
  • Summary: Update Target
  • Description: Update an existing target.
  • Operation ID: update_target_v1

Parameters:​

ParameterTypeDescriptionRequired
target_idstring/integerUnique identifier for the targetYes

Request Body:​

{
  "target_name": "updated_name",
  "domain_name": "updated.example.com"
}

Example Response:​

{
  "status_code": 200,
  "message": "Successfully updated target."
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
409Conflictapplication/json
500Internal Server Errorapplication/json

PUT /aiwb/bot/api/v3/targets/{target_id}​

  • Method: PUT
  • Summary: Update Target (V3)
  • Description: V3 version of the Update Target endpoint.
  • Operation ID: update_target_v3

Responses:

Same as V1 version.

DELETE /aiwb/bot/api/v1/targets/{target_id}​

  • Method: DELETE
  • Summary: Delete Target
  • Description: Delete an existing target.
  • Operation ID: delete_target_v1

Parameters:​

ParameterTypeDescriptionRequired
target_idstring/integerUnique identifier for the targetYes

Example Response:​

{
  "status_code": 200,
  "message": "Successfully deleted target."
}

Responses:

Status CodeDescriptionContent-Type
200Successful Responseapplication/json
400Bad Requestapplication/json
401Unauthorizedapplication/json
403Forbiddenapplication/json
404Not Foundapplication/json
500Internal Server Errorapplication/json

DELETE /aiwb/bot/api/v3/targets/{target_id}​

  • Method: DELETE
  • Summary: Delete Target (V3)
  • Description: V3 version of the Delete Target endpoint.
  • Operation ID: delete_target_v3

Responses:

Same as V1 version.

Schemas​

ChatBotCreate​

  • Type: object
  • Description: Schema for creating a chatbot
  • Properties:
    • chatbotName: (string, required, min length: 3) - Name of the chatbot
    • chatbotDescription: (string) - Description of the chatbot's purpose
    • folder_ids: (array of strings, default: []) - Folder IDs to include for knowledge
    • object_ids: (array of strings, default: []) - Object IDs to include for knowledge
    • guideline_object_ids: (array of strings, default: []) - Guideline object IDs
    • template_object_id: (array with exactly one string) - Template object ID
    • modelId: (string, required, min length: 3) - ID of the model to use
    • modelVersion: (string, required, min length: 2) - Version of the model
    • context: (string, default: "") - System context for the chatbot
    • temperature: (number, range: 0-2, default: 0) - Temperature parameter
    • max_tokens: (integer, min: 1, default: 1) - Maximum tokens in response
    • top_p: (number, range: 0-1, default: 0) - Top-p parameter
    • top_k: (integer, range: 1-500, default: 1) - Top-k parameter
    • frequency_penalty: (number, range: 0-2, default: 0) - Frequency penalty
    • presence_penalty: (number, range: 0-2, default: 0) - Presence penalty
    • best_of: (integer, range: 1-20, default: 1) - Best of parameter
    • guard_rail: (array of strings, default: []) - Guard rails to apply
    • examples: (array of objects, default: []) - Example Q&A pairs
      • question: (string) - Example question
      • answer: (string) - Example answer
    • category: (string, max length: 50) - Chatbot category
    • bot_icon: (string, max length: 200) - URL to bot icon
    • tool_config: (object) - Tool configuration
      • content_lake: (boolean, default: true) - Whether to use content lake
      • web_search: (boolean, default: false) - Whether to use web search

Response Codes​

CodeDescription
200Success
201Created
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation Error
500Internal Server Error

Version Differences​

V1 to V2​

  • Added group_by functionality
  • Enhanced filtering capabilities
  • Added model filtering options
  • Made some fields optional in update endpoints

V2 to V3​

  • Changed List endpoint from GET to POST for complex queries
  • Added more required fields in Create for better bot configuration
  • Added embedding profiles support
  • Improved error messages and validation
  • Enhanced grouping and filtering capabilities